Skip to content

update installation instructions#295

Merged
jfly merged 3 commits intoNixOS:masterfrom
fricklerhandwerk:installation
May 9, 2025
Merged

update installation instructions#295
jfly merged 3 commits intoNixOS:masterfrom
fricklerhandwerk:installation

Conversation

@fricklerhandwerk
Copy link
Contributor

@fricklerhandwerk fricklerhandwerk commented Apr 29, 2025

this looks like a scary large change, but it really does the following:

  • group installation methods by target (environment, editor, project)
  • add Home Manager and mkShell
  • simplify the examples for treefmt-nix and git-hooks.nix
  • add admonitions for the samples that require treefmt in the
    environment
  • remove nix-env, because that's the easiest way to discourage its use
  • move nix fmt to the end, because it takes much space for little benefit
    (interactive use is impractical: invoking it requires a full evaluation every time,
    while all environment and auto-config options run instantly)

this looks like a scary large change, but it really does the following
- group installation methods by target (environment, editor, project)
- add Home Manager and `mkShell`
- simplify the examples for `treefmt-nix` and `git-hooks.nix`
- add admonitions for the samples that require `treefmt` in the
  environment
- remove `nix-env`, because that's the easiest way to discourage its use
- move `nix fmt` to the end, because it takes much space for little benefit
  (interactive use is impractical: invoking it requires a full evaluation every time,
  while all environment and auto-config options run instantly)
@github-actions
Copy link

github-actions bot commented Apr 29, 2025

Nixpkgs diff

@nixos-discourse
Copy link

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/formatting-team-meeting-2025-04-29/63649/1

Copy link
Collaborator

@jfly jfly left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. There's room for future improvement, which we'll deal with later.

@jfly jfly merged commit 6fae252 into NixOS:master May 9, 2025
2 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Nix formatting May 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

5 participants